home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr23 / dirx110.zip / DIRX.DOC < prev    next >
Text File  |  1993-06-29  |  12KB  |  276 lines
  1. DirX-Directory of eXecutables, Version 1.10             29-Jun-93
  2.  
  3.  
  4. Shell for detecting files compressed by several executable file compressors.
  5. Calls on user-selectable external programs to transparently compress and
  6. uncompress files from within the program.  Currently supported are AXE,
  7. DIET, EXEPACK, ICE, LEXEM, LZEXE, PKLITE, SCRNCH, SHRINK and TINYPROG.
  8.  
  9. Contents:
  10. =========
  11. Purpose
  12. Display
  13. Syntax
  14. Switches
  15. Configuration
  16. Commands
  17. Pull-down menus
  18.  
  19. Purpose:
  20. ========
  21. To show which .EXE and .COM files have and have not been compressed by one
  22. of the supported executable file compressors and to allow for transparent
  23. compression and uncompression of individual and groups of files by
  24. user-selectable compress and uncompress commands.
  25.  
  26. DirX is a free program (freeware).
  27.  
  28. Display:
  29. ========
  30. When the program is started, two windows pop up displaying any compressed
  31. files and/or directories on the left and any non-compressed files on the
  32. right.  The window on the left is slightly wider to allow an abbreviated
  33. three-character identifier to precede each filename - currently "axe",
  34. "die", "epk", "ice", "lex", "lze", "pkl", "scr", "shr" or "tny" for files
  35. compressed by AXE, DIET, EXEPACK, ICE, LEXEM, LZEXE, PKLITE, SCRNCH, SHRINK
  36. and TINYPROG, respectively.
  37.  
  38. In addition to the file name, and type in the compressed window, the default
  39. display also shows the file size, date and time for each file.  Using the
  40. "Toggle" command, the current window can be set to show any special
  41. characteristics ("Special"), file attributes ("Attr"), the probable correct
  42. extension for the file name if it has been misnamed ("Mis") and which
  43. version of the compressor was used in the case of DIET, LZEXE, PKLITE and
  44. TINYPROG files.
  45.  
  46. Please note that as DIET, at least up until version 1.44, does not
  47. explicitly store the version number, any version number greater than 1.00
  48. can only be interpreted in the "greater than or equal to" sense.  Thus a
  49. reading of "1.01" means that a version of DIET equal to 1.01, or higher, was
  50. used to compress a file.
  51.  
  52. Files compressed with PKLITE Professional's extra-compression option have an
  53. 'e' appended to the version number.
  54.  
  55. Special characteristics displayed using the Toggle command are as follows: 
  56. For the Compressed window, "dat" for "data" files (non-executables)
  57. compressed with DIET.  For the Uncompressed window, "ovl" for possible
  58. executables containing overlays, "win" for Windows/OS2 executables and "lhi"
  59. for LoadHi executables.
  60.  
  61. The program displays either in color or "black-and-white" based on the video
  62. mode at program start-up.  However, if the user has a color graphics card,
  63. but no color monitor, the display may be improved by using the DOS command
  64. "MODE BW80".  Conversely, color mode may be forced on by using "MODE CO80".
  65.  
  66. A command-line switch is also available to force black-and-white mode (see
  67. "Switches").
  68.  
  69. EGA/43- and VGA/50-line modes are supported.  At program start-up, an
  70. attempt is made to detect the actual number of lines on the screen, up to a
  71. maximum of 50, and to adjust the display accordingly.
  72.  
  73. Syntax:
  74. =======
  75.  
  76.         Usage:  DIRX [switches] [filespec]
  77.  
  78. In the above syntax, if no argument follows the program name, the current
  79. default directory is searched, which is equivalent to "DIRX *.*".  If no
  80. file extension is specified, all extensions are searched.
  81.  
  82. Switches:
  83. =========
  84.  
  85. /A      display Alternate info for both windows at start-up.  Simpler than
  86.         selecting each window in turn from within the program and using the
  87.         Toggle command twice.
  88.  
  89. /BW     Black-and-White mode.  Provided as an alternative to using DOS's
  90.         "MODE BW80" command.
  91.  
  92. Either '/' or '-' may be used to specify switches.
  93.  
  94. Entering an invalid switch causes the program to display a brief help screen
  95. then exit.
  96.  
  97.         Examples:       DIRX /h
  98.                         DIRX -?
  99.  
  100. Configuration:
  101. ==============
  102. An optional configuration file containing user-selected default switches may
  103. be created or edited with any editor or word processor which can save pure
  104. ASCII text files.  This file should be named "DIRX.CFG" and placed in the
  105. same directory from which DIRX.EXE will be loaded (DOS 3.0 and above).
  106.  
  107. Switches, including switch options, may be separated by spaces or placed on
  108. separate lines.
  109.  
  110. In addition to specifying "true" switches, DIRX.CFG should also contain
  111. lines assigning which commands to use for compressing and uncompressing
  112. files of the appropriate type.  Although the syntax of DIRX.CFG allows for
  113. uncompress commands for any of the supported formats, the related
  114. decompressor for a particular type may not exist at the present time.
  115.  
  116. The syntax for specifying the *single* compress command is:
  117.  
  118. /C="command"
  119.  
  120. Where:  "command" should be set to the command line, including arguments, of
  121.           the compress command you wish to run.
  122.  
  123. "command" would typically include both the "%f" and "%e" format specifiers,
  124. which represent the filename and extension, respectively, of the selected
  125. file.
  126.  
  127. If "filename.ext" is a target file, then %f represents the "filename"
  128. portion of the complete filename, and %e represents the ".ext" part.
  129.  
  130.         Examples:       /C="PKLITE %f%e"
  131.                         /C="AXE %f%e -n"
  132.                         /C="EXEPACK %f%e %f.EPK"
  133.  
  134. If DIRX.CFG contains more than one line with the correct syntax for
  135. specifying the compress command, the last one encountered before end of file
  136. will be used.
  137.  
  138. The default command for specifying the method of compression may be
  139. temporarily overridden from within the program.  More about this later in
  140. the "Commands" section.
  141.  
  142. The syntax for specifying the uncompress commands is:
  143.  
  144. /U<xxx>="command"
  145.  
  146. Where:  <xxx> is "axe", "die", "epk", "ice", "lex", "lze", "pkl", "scr",
  147.           "shr" or "tny" for files compressed with AXE, DIET, EXEPACK, ICE,
  148.           LEXEM, LZEXE, PKLITE, SCRNCH, SHRINK or TINYPROG, respectively.
  149.  
  150. "command" would be formed similarly to specifying the compress command.
  151.  
  152.         Examples:       /Upkl="PKLITE %f%e -x"
  153.                         /Udie="DIET -ra %f%e"
  154.                         /Uepk="UPACKEXE %f%e"
  155.  
  156. If DIRX.CFG contains more than one line with the correct syntax for
  157. specifying the uncompress command for the related type of compressed file,
  158. the last one encountered before end of file will be used.
  159.  
  160. True switches should be placed on separate lines from those assigning
  161. commands.
  162.  
  163. A sample DIRX.CFG file is included in the distribution archive for DirX,
  164. which the user may edit to "customize" DirX's behavior.
  165.  
  166. Commands:
  167. =========
  168. The current or active window is the one with the solid frame.  Within the
  169. active window, <Home>, <End>, <PgUp>, <PgDn>, <UpArrow> and <DownArrow> may
  170. be used to navigate.  The <Tab> and right/left arrow keys will toggle the
  171. active window between the left and right panels.
  172.  
  173. If any directories are displayed in the left (Compressed) window, moving the
  174. file selection bar (highlight) over that directory and pressing <Return>
  175. will change the directory being viewed.  The file lists will be updated
  176. automatically.
  177.  
  178. Two shortcut keys are available for navigating directories while in the
  179. Compressed window:
  180.  
  181. "Ctrl \" changes the current directory to the root directory - similar to
  182. "CD \" at the DOS level.
  183.  
  184. "Ctrl <PgUp>" changes the current directory to the parent directory -
  185. similar to "CD .." from DOS.
  186.  
  187. To change the current default drive from within the program, use either "Alt
  188. <F1>" or "Alt <F2>".  A window indicating valid drives will pop up, allowing
  189. the user to select another drive by moving the highlight with the left and
  190. right arrow keys, then pressing <Return> to select the new drive.  As an
  191. alternative, you may also type the letter of the drive.  Press <Esc> to
  192. leave the default drive unchanged.  The drive changing feature is only valid
  193. when using versions of DOS numbered 3.0 or higher.
  194.  
  195. Pressing <F1> or the letter 'H' will display a brief help screen summarizing
  196. commonly used commands.  Press any key to close the help window.
  197.  
  198. Pressing <F3> or the letter 'D' will turn Directories-only mode on.  To turn
  199. Directories-only mode off, press <F3> or 'D' a second time.  (This feature
  200. was added by user request to speed up navigation on a relatively slow
  201. machine.)
  202.  
  203. Pressing <F4> or the letter 'T' will toggle the active window's display to
  204. show additional information on the files being displayed, as previously
  205. described in the "Displayed data" section above.
  206.  
  207. Pressing <F6> or the letter 'M' when no files have been selected will cause
  208. the Move command to act on the currently highlighted file.  If any files
  209. have been selected, the Move command acts on the selected files.
  210.  
  211. If the Move command is given while in the "Compressed" window, the
  212. uncompress command is executed for each selected file.
  213.  
  214. If the Move command is given while in the "Uncompressed" window, the
  215. compress command is executed for each selected file.
  216.  
  217. Pressing "Alt <F6>" or "Alt M" from either the Compressed or Uncompressed
  218. window will open an input window which will allow the user to temporarily
  219. "Alter", or override, the method of compression currently defined in
  220. DIRX.CFG, on the fly, from within DirX.
  221.  
  222. For compressing and uncompressing to work, the appropriate commands should
  223. either be available in a directory included in the PATH environment
  224. variable, or in the current directory.
  225.  
  226. Files may be tagged either individually or by wildcard selection.  The <Ins>
  227. key may be used as a toggle to select and unselect individual files. 
  228. Pressing <Ins> on an unselected file selects it.  Pressing <Ins> on a
  229. selected file unselects it.  To select a group of files using DOS-type
  230. wildcards, press the plus ('+') key.  This opens up an input window into
  231. which a file specification may be entered.  To unselect a group of files,
  232. press the minus ('-').  This opens up an input window similar to the one for
  233. selection.  The suggested keys are the gray plus and minus keys found near
  234. the numeric keypad of many keyboards.
  235.  
  236. Pressing <F7> or the letter 'S' will open an input window for the user to
  237. enter a file specification to search for within the current window.  If
  238. wildcards are used, and the Search command is repeatedly invoked without
  239. changing the search specification, the program will cycle through all
  240. matching file names.
  241.  
  242. Pressing <F9> or the letter 'P' or '/' will invoke the pull-down menu
  243. system.
  244.  
  245. Pressing <Esc>, <F10> or the letter 'Q' will exit the program.
  246.  
  247. Pull-down menus:
  248. ================
  249. The pull-down menu system duplicates in functionality many of the commands
  250. already described in the Commands section.  The purpose of this menu system
  251. is to de-emphasize the use of function keys and cryptic Alt- and Ctrl-key
  252. sequences when adding new commands in the future.
  253.  
  254. The Move command, invoked by function key, is replaced by two separate
  255. commands in the pull-down menu system.  These are the "Compress" and
  256. "Uncompress" options, listed under the "File" submenu.
  257.  
  258. For the Uncompress menu option to work, the Compressed window must be the
  259. current one.  This option is equivalent to using the Move command while in
  260. the Compressed window.
  261.  
  262. The Compress menu option, depending on which window is active, can act on
  263. files in *either* the Compressed or Uncompressed windows.  The purpose of
  264. allowing the user to *attempt to* compress already compressed files
  265. (available from the command line anyway) is to facilitate experimentation on
  266. the effects of compression by a variety of methods - compressing files
  267. already compressed with EXEPACK, for example.
  268.  
  269. --
  270.  
  271.                 Raymond T. Kaya
  272.                 P. O. Box 1436
  273.                 Honolulu, HI  96806
  274.  
  275.                 CompuServe:  71230,2500
  276.